/*
 * Copyright 2023 Greptime Team
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.greptime.common.signal;

/**
 * This is the signal handler interface.
 */
public interface SignalHandler {

    /**
     * The type of signal will be handled.
     *
     * @return signal type
     */
    default Signal signal() {
        return Signal.SIG_USR2;
    }

    /**
     * Handle the given signal.
     *
     * @param signalName signal name
     */
    void handle(String signalName);
}
